home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / ifl / iflSize.z / iflSize
Encoding:
Text File  |  1998-10-20  |  5.5 KB  |  199 lines
  1.  
  2.  
  3.  
  4. iiiiffffllllSSSSiiiizzzzeeee((((3333))))        IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiiffffllllSSSSiiiizzzzeeee((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiiffffllllSSSSiiiizzzzeeee - defines the size of an IL image
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      This is a base class and therefore has no inheritance.
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <ifl/iflSize.h>
  16.  
  17. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      This object is used to describe the size of an IL image. It is mostly
  19.      used to group the four values describing the (_x, _y, _z, _c) size of an
  20.      image together in a convenient way.  An iflSize object can be declared in
  21.      the following way:
  22.  
  23.               // unitialized
  24.               iflSize size;
  25.  
  26.               // initialized
  27.               iflSize size(X_SIZE, Y_SIZE, Z_SIZE, C_SIZE);
  28.               iflSize size(X_SIZE, Y_SIZE, C_SIZE);
  29.               iflSize size(otherSizeObj);
  30.  
  31.  
  32.      Several useful operators are provided to extract the total size and to
  33.      perform direct comparisons between iflSize objects.
  34.  
  35. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  36.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrrssss
  37.  
  38.           iflSize()
  39.           iflSize(int x, int y, int c=1)
  40.           iflSize(int x, int y, int z, int c)
  41.           iflSize(const iflSize& size)
  42.  
  43.  
  44.      IIIInnnniiiittttiiiiaaaalllliiiizzzzaaaattttiiiioooonnnn
  45.  
  46.           void init(int x, int y, int z, int c)
  47.  
  48.  
  49.      OOOOppppeeeerrrraaaattttoooorrrrssss
  50.  
  51.           operator int() const
  52.           void operator=(const iflSize& from)
  53.           operator!=(const iflSize& rhs)  const
  54.           operator==(const iflSize& rhs)  const
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiiffffllllSSSSiiiizzzzeeee((((3333))))        IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiiffffllllSSSSiiiizzzzeeee((((3333))))
  71.  
  72.  
  73.  
  74. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  75.      iiiiffffllllSSSSiiiizzzzeeee(((())))
  76.  
  77.           iflSize()
  78.           iflSize(int x, int y, int c=1)
  79.           iflSize(int x, int y, int z, int c)
  80.           iflSize(const iflSize& size)
  81.  
  82.  
  83.           The first version with no arguments constructs an uninitialized
  84.           iflSize.  The second version constructs an iflSize with the size set
  85.           to (_x, _y, _c). Note that c and z default to 1.  The third version
  86.           constructs an iflSize with the size set to (_x, _y, _z, _c).  The final
  87.           version constructs an iflSize whose values are taken from _s_i_z_e.
  88.  
  89.      vvvvooooiiiidddd iiiinnnniiiitttt(((())))
  90.  
  91.           void init(int x, int y, int z, int c)
  92.  
  93.  
  94.           Thi method initializes the size to (_x, _y, _z, _c).
  95.  
  96.      ooooppppeeeerrrraaaattttoooorrrr iiiinnnntttt(((())))
  97.  
  98.           operator int() const
  99.  
  100.  
  101.           The iiiinnnntttt cast operator returns the product of the dimensions,
  102.           _x*_y*_z*_c.
  103.  
  104.      ooooppppeeeerrrraaaattttoooorrrr====(((())))
  105.  
  106.           void operator=(const iflSize& from)
  107.  
  108.  
  109.           The assignment operator copies _f_r_o_m into the iflSize object it is
  110.           invoked on.
  111.  
  112.      ooooppppeeeerrrraaaattttoooorrrr!!!!====(((())))
  113.  
  114.           operator!=(const iflSize& rh) const
  115.  
  116.  
  117.           The inequality operator compares two iflSize objects and returns
  118.           TRUE if any of the corresponding (_x, _y, _z, _c) members differ, FALSE
  119.           otherwise.
  120.  
  121.      ooooppppeeeerrrraaaattttoooorrrr========(((())))
  122.  
  123.           operator==(const iflSize& rh) const
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiiffffllllSSSSiiiizzzzeeee((((3333))))        IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiiffffllllSSSSiiiizzzzeeee((((3333))))
  137.  
  138.  
  139.  
  140.           The equality operator compares two iflSize objects and returns TRUE
  141.           if all of the corresponding (_x, _y, _z, _c) members are the same, FALSE
  142.           otherwise.
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.